/*****************************************************************************
  Copyright ?2002-2004 by Martin Cook. All rights are reserved. If you like
  this code then feel free to go ahead and use it. The only thing I ask is 
  that you don't remove or alter my copyright notice. Your use of this 
  software is entirely at your own risk. I make no claims about the 
  reliability or fitness of this code for any particular purpose. If you 
  make changes or additions to this code then please clearly mark your code 
  as yours. If you have questions or comments then please contact me at: 
  martin@codegator.com
  
  Have Fun! :o)
*****************************************************************************/

using System;
using System.Data;

namespace CG.Security.Data
{

	/// <summary>
	/// Data access operations for associations between users and roles.
	/// </summary>
	public interface IUserRoleData
	{

		/// <summary>
		/// Creates a new association between a user and a role.
		/// </summary>
		/// <param name="userID">The identifier for the user.</param>
		/// <param name="roleID">The identifier for the role.</param>
		void Create(
			int userID,
			int roleID
			);

		// ******************************************************************

		/// <summary>
		/// Deletes an association between a user and a role.
		/// </summary>
		/// <param name="userID">The identifier for the user.</param>
		/// <param name="roleID">The identifier for the role.</param>
		void Delete(
			int userID,
			int roleID
			);

		// ******************************************************************

		/// <summary>
		/// Returns a list of all the users associated with the specified role.
		/// </summary>
		/// <param name="userID">The identifier for the user.</param>
		/// <returns>A DataSet containing all the users associated with the 
		/// specified role.</returns>
		System.Data.DataSet FindByUser(
			int userID
			);

		// ******************************************************************

		/// <summary>
		/// Returns a list of all the roles associated with the specified user.
		/// </summary>
		/// <param name="roleID">The identifier for the role.</param>
		/// <returns>A DataSet containing all the roles associated with the 
		/// specified user.</returns>
		System.Data.DataSet FindByRole(
			int roleID
			);

	} // End IUserRoleData

} // End namespace CG.Security.Data

